ArcPad Extension Preferences File Schema
LISTBOX Element
See Also  Send comments on this topic.
ArcPad Extension Preferences File Schema > PAGE Element : LISTBOX Element

Glossary Item Box

Description

Used to define a ListBox control in a form.

Diagram

LISTITEM Element Sequence LISTBOX Element

Overview

LISTBOX
Used to define a ListBox control in a form.
height required Restriction of xs:int
width required Restriction of xs:int
x required xs:int
The x coordinate of the upper left corner of the list box.
y required xs:int
The y coordinate of the upper left corner of the list box
backgroundcolor optional xs:string
border optional Restriction of xs:string
color optional xs:string
defaultvalue optional xs:string
field optional xs:string
font optional xs:string
fontsize optional Restriction of xs:int
fontstyle optional Restriction of xs:string
group optional Restriction of xs:string
hscroll optional Restriction of xs:string
listtable optional xs:string
listtextfield optional xs:string
listvaluefield optional xs:string
name optional xs:string
onkillfocus optional xs:string
Specify the script to run when this event occurs.
onselcancel optional xs:string
Specify the script to run when this event occurs.
onselchange optional xs:string
Specify the script to run when this event occurs.
onsetfocus optional xs:string
Specify the script to run when this event occurs.
onvalidate optional xs:string
Specify the script to run when this event occurs.
readonly optional Restriction of xs:string
required optional Restriction of xs:string
showvalues optional Restriction of xs:string
sort optional Restriction of xs:string
tabstop optional Restriction of xs:string
vscroll optional Restriction of xs:string
Sequence
LISTITEM 1..∞
Used to define an item in a ComboBox or ListBox form control.

Attributes

NameTypeUseDefaultFixedDescription
heightRestriction of xs:intrequired   
widthRestriction of xs:intrequired   
xxs:intrequired  The x coordinate of the upper left corner of the list box.
yxs:intrequired  The y coordinate of the upper left corner of the list box
backgroundcolorxs:stringoptional   
borderRestriction of xs:stringoptionalfalse  
colorxs:stringoptional   
defaultvaluexs:stringoptional   
fieldxs:stringoptional   
fontxs:stringoptional   
fontsizeRestriction of xs:intoptional   
fontstyleRestriction of xs:stringoptionalregular  
groupRestriction of xs:stringoptionalfalse  
hscrollRestriction of xs:stringoptionalfalse  
listtablexs:stringoptional   
listtextfieldxs:stringoptional   
listvaluefieldxs:stringoptional   
namexs:stringoptional   
onkillfocusxs:stringoptional  Specify the script to run when this event occurs.
onselcancelxs:stringoptional  Specify the script to run when this event occurs.
onselchangexs:stringoptional  Specify the script to run when this event occurs.
onsetfocusxs:stringoptional  Specify the script to run when this event occurs.
onvalidatexs:stringoptional  Specify the script to run when this event occurs.
readonlyRestriction of xs:stringoptionalfalse  
requiredRestriction of xs:stringoptionalfalse  
showvaluesRestriction of xs:stringoptional   
sortRestriction of xs:stringoptionaltrue  
tabstopRestriction of xs:stringoptionaltrue  
vscrollRestriction of xs:stringoptionalfalse  

Examples

ArcPad layer file (*.apl) with an edit form.

Restrictions

The following attributes can only be used in edit and identify forms. They cannot be used in general forms:; field; required

Source

<xs:element name="LISTBOX" maxOccurs="1" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define a ListBox control in a form.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="LISTITEM" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>Used to define an item in a ComboBox or ListBox form control.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:attribute use="required" ref="height">
      <xs:annotation>
        <xs:documentation>The height of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" ref="width">
      <xs:annotation>
        <xs:documentation>The width of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="x" type="xs:int">
      <xs:annotation>
        <xs:documentation>The x coordinate of the upper left corner of the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="y" type="xs:int">
      <xs:annotation>
        <xs:documentation>The y coordinate of the upper left corner of the list box</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the list box. If not specified, this value is inherited from the page's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="border">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box has a border.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="color">
      <xs:annotation>
        <xs:documentation>The color to use for the list box's text. If not specified, this value is inherited from the page's color attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="defaultvalue">
      <xs:annotation>
        <xs:documentation>A simple expression that specifies the default value of the combo box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="field">
      <xs:annotation>
        <xs:documentation>The field of the shapefile's DBF table that is linked to the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="font">
      <xs:annotation>
        <xs:documentation>The font to use for the list box's text. If not specified, this value is inherited from the page's font attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="fontsize">
      <xs:annotation>
        <xs:documentation>The font size to use for the list box's text. If not specified, this value is inherited from the page's fontsize attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="regular" ref="fontstyle">
      <xs:annotation>
        <xs:documentation>The font style to use for the list box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="group" default="false">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box starts a new group of controls.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="hscroll">
      <xs:annotation>
        <xs:documentation>Specifies if the list box should have a horizontal scroll bar</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="listtable">
      <xs:annotation>
        <xs:documentation>The DBF table used to populate the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="listtextfield">
      <xs:annotation>
        <xs:documentation>The field of the DBF table that contains the data used to populate the text component of the list box's items.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="listvaluefield">
      <xs:annotation>
        <xs:documentation>The field of the DBF table that contains the data used to populate the value component of the list box's items.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="name">
      <xs:annotation>
        <xs:documentation>Name of the ListBox control. Used to reference the control in scripts.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onkillfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onselcancel">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onselchange">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onsetfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onvalidate">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="readonly">
      <xs:annotation>
        <xs:documentation>Specifies whether the list box's value can be modified by the user.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="required">
      <xs:annotation>
        <xs:documentation>Specifies if the user must enter some text in the list box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="showvalues" />
    <xs:attribute ref="sort">
      <xs:annotation>
        <xs:documentation>Specifies if the items in the list box are automatically sorted alphabetically.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="tabstop">
      <xs:annotation>
        <xs:documentation>Specifies if the items in the list box are automatically sorted alphabetically.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="vscroll">
      <xs:annotation>
        <xs:documentation>Specifies if the list box should have a vertical scroll bar</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2012 All Rights Reserved.